home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Screenblankers / Aurora / Aurora_15a.Doc < prev    next >
Text File  |  1996-09-26  |  45KB  |  1,286 lines
  1.  
  2.  
  3.  
  4.             IT IS ILLEGAL TO MAKE UNAUTHORIZED COPIES OF THIS SOFTWARE
  5.  
  6.           This software is protected under federal copyright law.  It is
  7.         illegal to make or distribute copies of this software except to
  8.         make a backup for archival purposes only.  Duplication of this
  9.         software for any other reason including for sale, loan, rental,
  10.         or gift is a federal crime.  Penalties include fines as high as
  11.         $50,000 and jail terms of up to five years.
  12.  
  13.                                  COPYRIGHT NOTICE
  14.  
  15.           This manual and the software described in this manual are
  16.         copyrighted.  All rights reserved.  No part of this documentation
  17.         or described software may be copied, reproduced, translated, or
  18.         reduced to any machine-readable form without the prior written
  19.         consent of Inline Services, P.O.  Box 3204, Hampton, VA
  20.         23663-0204.
  21.           The demonstration version of this software is freely
  22.         distributable via normal public domain channels so long as the
  23.         archive is in its original form as provided by Inline Services,
  24.         and no charges are incurred by the user.  You are prohibited from
  25.         seperating, altering, or using any file not contained within the
  26.         "Freeware" directory of said original archive for any purpose
  27.         other than demonstration of Aurora.  The demonstration version
  28.         has it's Arexx port disabled, limiting users to their "default
  29.         ModeID", and the F10 key will not save the current screen.
  30.  
  31.         * Amiga is a registered trademark of Amiga Technologies.
  32.         * OpalVision is a registered trademark of Centaur Development.
  33.         * Art Department Professional is a registered trademark of ASDG.
  34.  
  35.         Installer and Installer project icon (c) Copyright 1991-93
  36.         Commodore-Amiga, Inc. All Rights Reserved. Reproduced and
  37.         distributed under license from Commodore.
  38.  
  39.         INSTALLER SOFTWARE IS PROVIDED "AS-IS" AND SUBJECT TO CHANGE; NO
  40.         WARRANTIES ARE MADE.  ALL USE IS AT YOUR OWN RISK.  NO LIABILITY
  41.         OR RESPONSIBILITY IS ASSUMED.
  42.  
  43.         Aurora v1.5 and above provides support for ptreplay.library v5.14
  44.         by Mattias Karlsson.  This library is freeware and is provided
  45.         with Aurora for completeness.  PTReplay.library is NOT required
  46.         for Aurora MOD file playback.  No additional cost has been added
  47.         due to its use or inclusion.
  48.  
  49.         PTReplay.library version 5.14 by Mattias Karlsson.  1995
  50.         BetaSoft.  This version is freeware.  You may use this library,
  51.         and also copy it further, provided that NO CHARGE is claimed. 
  52.         This message must always accompany any files in the
  53.         PTReplay.library that are distributed.
  54.  
  55.  
  56.  
  57.         Introduction to Aurora  . . . . . . . . . . . . . . . . . . . .  1
  58.  
  59.         Aurora System Requirements  . . . . . . . . . . . . . . . . . .  1
  60.  
  61.         Installing Aurora . . . . . . . . . . . . . . . . . . . . . . .  1
  62.  
  63.         Aurora Preference Editor  . . . . . . . . . . . . . . . . . . .  3
  64.             Switches Section  . . . . . . . . . . . . . . . . . . . . .  3
  65.             Preference Editor Hotkey Section  . . . . . . . . . . . . .  3
  66.             Password Protection Section   . . . . . . . . . . . . . . .  4
  67.             Driver Selection  . . . . . . . . . . . . . . . . . . . . .  4
  68.             Module Selection  . . . . . . . . . . . . . . . . . . . . .  4
  69.             Unblanking Input Events Section   . . . . . . . . . . . . .  4
  70.             Miscellaneous Gadgets   . . . . . . . . . . . . . . . . . .  5
  71.  
  72.         Aurora Variable Editor  . . . . . . . . . . . . . . . . . . . .  6
  73.  
  74.         Random Module Configuration . . . . . . . . . . . . . . . . . .  8
  75.  
  76.         Aurora/Commodities Exchange Interface . . . . . . . . . . . . .  9
  77.  
  78.         Aurora Display Driver Capabilities  . . . . . . . . . . . . . . 10
  79.  
  80.         Aurora Module Descriptions  . . . . . . . . . . . . . . . . . . 11
  81.             Common Information  . . . . . . . . . . . . . . . . . . . . 11
  82.             Arexx Module  . . . . . . . . . . . . . . . . . . . . . . . 11
  83.             Aswarm Module   . . . . . . . . . . . . . . . . . . . . . . 12
  84.             Clock Module  . . . . . . . . . . . . . . . . . . . . . . . 12
  85.             Cycle Module  . . . . . . . . . . . . . . . . . . . . . . . 12
  86.             Julia Module  . . . . . . . . . . . . . . . . . . . . . . . 12
  87.             JuliaFP Module  . . . . . . . . . . . . . . . . . . . . . . 13
  88.             Lines Module  . . . . . . . . . . . . . . . . . . . . . . . 13
  89.             Mandelbrot Module   . . . . . . . . . . . . . . . . . . . . 13
  90.             MandelbrotFP Module   . . . . . . . . . . . . . . . . . . . 13
  91.             Marquee Module  . . . . . . . . . . . . . . . . . . . . . . 14
  92.             Mystic Module   . . . . . . . . . . . . . . . . . . . . . . 14
  93.             Null Module   . . . . . . . . . . . . . . . . . . . . . . . 14
  94.             Plasma Module   . . . . . . . . . . . . . . . . . . . . . . 15
  95.             Puzzle Module   . . . . . . . . . . . . . . . . . . . . . . 15
  96.             Raindrops Module  . . . . . . . . . . . . . . . . . . . . . 15
  97.             Random Module   . . . . . . . . . . . . . . . . . . . . . . 15
  98.             SlideShow Module  . . . . . . . . . . . . . . . . . . . . . 15
  99.             Squares Module  . . . . . . . . . . . . . . . . . . . . . . 15
  100.             Starfield Module  . . . . . . . . . . . . . . . . . . . . . 16
  101.  
  102.         Aurora Arexx Interface Information  . . . . . . . . . . . . . . 17
  103.             MODULE Command  . . . . . . . . . . . . . . . . . . . . . . 17
  104.             DRIVER Command  . . . . . . . . . . . . . . . . . . . . . . 17
  105.             TIME Command  . . . . . . . . . . . . . . . . . . . . . . . 17
  106.             MOUSETIME Command   . . . . . . . . . . . . . . . . . . . . 17
  107.             OSCAN Command   . . . . . . . . . . . . . . . . . . . . . . 17
  108.  
  109.                                         i
  110.  
  111.  
  112.             MODEID Command  . . . . . . . . . . . . . . . . . . . . . . 17
  113.             MODULEMODEID Command  . . . . . . . . . . . . . . . . . . . 17
  114.             WINDOW Command  . . . . . . . . . . . . . . . . . . . . . . 18
  115.             VARx Command  . . . . . . . . . . . . . . . . . . . . . . . 18
  116.             STRx Command  . . . . . . . . . . . . . . . . . . . . . . . 18
  117.             HANGUP Command  . . . . . . . . . . . . . . . . . . . . . . 18
  118.             UNBLANK Command   . . . . . . . . . . . . . . . . . . . . . 18
  119.             QUIT Command  . . . . . . . . . . . . . . . . . . . . . . . 18
  120.             RANDOMTIME Command  . . . . . . . . . . . . . . . . . . . . 18
  121.             SOUND Command   . . . . . . . . . . . . . . . . . . . . . . 19
  122.             STARTCMD Command  . . . . . . . . . . . . . . . . . . . . . 19
  123.             STOPCMD Command   . . . . . . . . . . . . . . . . . . . . . 19
  124.  
  125.         Common ModeID Values for WB2.x Users  . . . . . . . . . . . . . 20
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.                                        ii
  166.  
  167.  
  168.         Introduction to Aurora
  169.  
  170.           Aurora is a modular screen saver utility.  Some of its major
  171.         features include:
  172.  
  173.         * Modular screen blanking routines that provide easy updates and
  174.           expansion.
  175.         * System friendly mouse blanker with congifurable time setting.
  176.         * Display driver libraries supporting all Amiga 16/32/256 color
  177.           screenmodes and the OpalVision video card.
  178.         * Registers as a system commodity.
  179.         * Each module is capable of unique numeric and string variable
  180.           definitions, screen resolution, music file, and start/stop
  181.           commands.
  182.         * Module variable editor which creates Arexx scripts with your
  183.           module preferences.
  184.         * Complete Arexx interface for easy system control.
  185.         * Optional Workbench status window.
  186.         * qRandom module capable of periodically reselecting another
  187.           module.
  188.         * Screen resolutions can be from any installed monitor.
  189.         * Eight user selectable unblanking events.
  190.         * System password protection.
  191.         * Complete support for WorkBench 3.x datatypes.
  192.  
  193.           Aurora is provided with 14 graphics modules, an Arexx
  194.         interface/script execution module, and a random selection module.
  195.  
  196.         Aurora System Requirements
  197.  
  198.           Aurora requires Amiga KickStart v2.04 or above, one megabyte
  199.         of chip ram, a 68000 or better processor, and one of the
  200.         following display devices:
  201.  
  202.         * Any Amiga non-HAM/non-EHB display.
  203.         * OpalVision video card.
  204.         * Picasso II or any other graphics card capable of selecting
  205.           it's screenmode through an operating system compliant monitor
  206.           type.
  207.  
  208.           Two megabytes of chip ram, any amount of fast ram, and a
  209.         68020+ processor are highly recommended.
  210.           Aurora runs from either Workbench or the CLI.  To use Aurora's
  211.         module variable capabilities, you must have RexxMast running. 
  212.         This is included with the Amiga system software.
  213.  
  214.         Installing Aurora
  215.  
  216.           To install Aurora double click the install icon.  You will be
  217.         presented with Amiga Technologies' standard installation program. 
  218.         You need to select a path where an Aurora directory will be
  219.         created, a default image loading path, and which modules the
  220.  
  221.                                         1
  222.  
  223.  
  224.         random module will use in its selection process.  After the files
  225.         have been copied into the new directory, an Aurora icon will be
  226.         placed in your SYS:WBStartup directory.  This is the most
  227.         convenient method of running Aurora.  During the installation,
  228.         you will be asked if you want your S:User-Startup file altered to
  229.         include an Aurora: assignment.  This is required for Aurora to
  230.         work properly.
  231.           Aurora will run automatically after the installation process
  232.         is complete, and the Preference Editor screen will open to allow
  233.         you to configure your default settings.
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.                                         2
  278.  
  279.  
  280.         Aurora Preference Editor
  281.  
  282.           Aurora's Preference Editor allows you to modify all of
  283.         Aurora's options via an intuition interface.
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.         Switches Section
  316.           The Switches section allows you to define the default screen
  317.         resolution that all modules will use.  This is accomplished via
  318.         the HIRES, LACED, OSCAN and Default ModeID gadgets.  These
  319.         resolution settings will apply only if you have not edited a
  320.         specific module's variable preferences.  The WINDOW gadget
  321.         enables or disables Aurora's WorkBench status window.
  322.  
  323.         Preference Editor Hotkey Section
  324.           This section allows you to define the hotkey sequence that
  325.         invokes the Preference Editor.  Select the key and qualifiers
  326.         that you want to use (you'll see by default they have 'L-ALT',
  327.         'CTRL', and KEY='A' selected).  You can choose ANY combination of
  328.         Left Alt, Right Alt, Left Shift, Right Shift, and Ctrl keys.  The
  329.         'KEY' selection can be any keypress that can be entered into this
  330.         gadget.  The keys selected must all be pressed simultaneously to
  331.         invoke the Preference Editor.  If you find that Aurora conflicts
  332.  
  333.                                         3
  334.  
  335.  
  336.         with another program supporting hotkeys, you will need to change
  337.         either Aurora's or the conflicting program's hotkey definitions.
  338.  
  339.         Password Protection Section
  340.           The gadgets under the 'Password Protection' label enable or
  341.         disable the protection feature.  If 'LOCK' is enabled, the string
  342.         gadget to it's right allows entry of your password.  Up to ten
  343.         characters can be entered and the password is case sensitive.  If
  344.         the password protection feature is enabled, you will be asked for
  345.         it any time you run Aurora, whenever the Preference Editor is
  346.         invoked and after a module has unblanked.
  347.  
  348.         Driver Selection
  349.           The listview gadget under the Display section allows you to
  350.         select from any of the supported display drivers.  The selected
  351.         driver name will be highlighted.  If the selected driver is
  352.         invalid on your system (IE Selecting the OpalVision driver on a
  353.         system that does not have an OpalVision), you will be notified of
  354.         this, and the driver will be deselected.
  355.           Each driver can have it's own default image directory.  To
  356.         edit this setting, double click on the driver name.  A small
  357.         window with standard Aurora file selection gadgets will open and
  358.         allow you to specify the directory you wish to use.  This enables
  359.         different drivers to use images that perhaps only it can load.
  360.           A display driver MUST be selected to exit the Preference
  361.         Editor and/or to edit any module preference settings.
  362.  
  363.         Module Selection
  364.           The gadgets under the 'Module' label allow selection of the
  365.         desired blanking module and the task priority of the module while
  366.         it is running.
  367.           The listview gadget contains the names of all modules
  368.         contained in the 'Aurora:Modules/' directory.  Click on the name
  369.         of the module you want to use.  The selected module name will be
  370.         highlighted.  If you want to edit a specific module's variable
  371.         settings, double click on it's name.  This will invoke the module
  372.         variable editor.  Double clicking on the Random module will open
  373.         the Random Module Configuration window.  A module MUST be
  374.         selected to exit the Preference Editor.
  375.  
  376.         Unblanking Input Events Section
  377.           This section allows you to specify which input events will
  378.         cause Aurora to unblank.  'Mouse Movement', 'Left Button', and
  379.         'Right Button' are all mouse related input events.  The
  380.         'Keypress', 'Disk Insertion', and 'Disk Removal' are
  381.         self-explanatory.  The 'Serial Carrier' and 'Serial Ring' gadgets
  382.         allow you to treat these serial.device events as input events. 
  383.         If either or both of the carrier or ring events are selected, the
  384.         device and unit as indicated by the cycle and device filename
  385.         gadgets will be opened in shared mode.  This may require you to
  386.         alter your preferences in other applications that also use the
  387.         selected device.  On some Amigas the printer ready signal from
  388.  
  389.                                         4
  390.  
  391.  
  392.         the parallel port and the serial ring signal from the serial port
  393.         interfer with each other.  If you select the Serial Ring event
  394.         and Aurora does not blank, try turning your printer on or off
  395.         (depending on the printer's state when the problem existed).
  396.           You can select any combination of input events, but at least
  397.         one must remain selected.  If you exit the Preference Editor
  398.         without any input events selected, Aurora will default to all
  399.         events enabled.  These input events are for unblanking purposes
  400.         only.  All possible input events are monitored while Aurora is
  401.         not blanked and will prevent Aurora from blanking if they are
  402.         detected.
  403.  
  404.         Miscellaneous Gadgets
  405.           The 'Screen Blanker Inactivity Period' slider determines the
  406.         number of seconds before screen blanking occurs.  The slider's
  407.         range is from 10-600 seconds (10 minutes).
  408.           The 'Mouse Blanker Inactivity Period' slider determines the
  409.         number of seconds before mouse blanking occurs.  The slider's
  410.         range is from 0-60 seconds.  Setting the slider to 0 disables the
  411.         mouse blanking feature.
  412.           The 'Save' button saves your preferences to the ENVARC: and
  413.         ENV: directories and they will be valid after any reboot.  The
  414.         'Use' button saves your preferences only to the ENV: directory,
  415.         so if you reboot, you'll need to reselect preferences or the
  416.         previously saved preferences will be used.  The 'Cancel' button
  417.         does just that, cancels without any saves.
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.                                         5
  446.  
  447.  
  448.         Aurora Variable Editor
  449.  
  450.           You enter the Variable Editor by double-clicking a module name
  451.         in the Preference Editor's "Modules" list gadget.  This queries
  452.         the module and provides a listing of all supported variables and
  453.         their descriptions.  It also displays authoring information and
  454.         any miscellaneous information pertinent to the module.
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.           Each numeric variable will have a corresponding slider gadget. 
  487.         Each string variable will have a corresponding string gadget and
  488.         possibly a '?' (AslRequester) gadget if the variable is intended
  489.         as a filename.  Each gadget is labeled with "VARx" or "STRx". 
  490.         These labels correspond to the Arexx keyword used to alter that
  491.         variable.  If a variable is not supported by the module, you will
  492.         not get a gadget for it.
  493.           The 'HIRES', 'LACED', and 'OSCAN' gadgets allow you to specify
  494.         custom screen resolutions for the module displayed in the
  495.         Variable Editor.  The MODEID gadget and associated '?' gadget
  496.         allow WB3.+ users to select the desired screenmode from the Asl
  497.         Screenmode Requester.  These settings override the global
  498.         resolution defined with the Preference Editor.
  499.           The "MOD Music" gadget and corresponding "?" allow you to
  500.  
  501.                                         6
  502.  
  503.  
  504.         select a Protracker music module to play while the module is
  505.         active.
  506.           The "Start Cmd" and "Exit Cmd" gadgets allow you to specify
  507.         AmigaDOS commands, scripts, or Arexx scripts to execute when the
  508.         module first blanks and after the module has unblanked.  These
  509.         can be used for any purpose and have been included for
  510.         flexibility.  Something to note is that Aurora automatically
  511.         performs an "Avail Flush" command after each module unblanks just
  512.         for general housekeeping.
  513.           At the bottom of the Variable Editor window are four
  514.         additional gadgets.  The 'Save' gadget generates an Arexx script
  515.         in your 'Aurora:Rexx/' directory for the module, based on the
  516.         slider, string, and screen resolution gadgets.  The 'Cancel'
  517.         gadget will return you to the Preference Editor window, ignoring
  518.         any changes made while in the Variable Editor.  The 'Defaults'
  519.         gadget initializes the slider and string gadgets to the default
  520.         values contained in the module.  The 'Test' gadget launches the
  521.         selected module with the current variable and screen resolution
  522.         settings.  This allows you to instantaneously see how the module
  523.         will perform.
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.                                         7
  558.  
  559.  
  560.         Random Module Configuration
  561.  
  562.           The Random Module Configuration window allows you to configure
  563.         all the options used by the Random module.
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.           The window is subdivided into two sections. The first section,
  596.         called "Module Selections", allows simple selection of which
  597.         modules can be picked by the Random module.  If you want a module
  598.         to be used in the random selection, click the box next to its
  599.         name.  Only the modules with check-marked boxes will be used in
  600.         the selection.
  601.           The second section, called "Miscellaneous Settings" allows you
  602.         to specify the "Auto Change Period" and the overall default image
  603.         directory.
  604.           The Auto Change Period is the amount of time each module is
  605.         ran before a new random module is selected. In the figure above,
  606.         you will see it is set to 0 hours and 15 minutes.  With these
  607.         settings, after each 15 minute time frame, the currently running
  608.         module will unblank, and a new one will be started.  The Auto
  609.         Change Period is configurable from 0 hours 0 minutes to 23 hours
  610.         59 minutes.  By setting both sliders to 0, the Auto Change
  611.         feature is disabled.
  612.  
  613.                                         8
  614.  
  615.  
  616.           The Overall Default Image Directory is used by Aurora to find
  617.         loadable image formats for any module that requires an image (EG
  618.         Slideshow, Puzzle, Cycle).  Each display driver is capable of
  619.         having it's own default image directory, but in the event you
  620.         have not configured a selected driver or no loadable images are
  621.         contained within the directory you have selected, the overall
  622.         image directory will be used.
  623.  
  624.         Aurora/Commodities Exchange Interface
  625.  
  626.           Aurora registers itself with the Commodities Exchange at
  627.         start-up.
  628.           The Commodities Exchange ACTIVE/INACTIVE gadget respectively
  629.         enables or disables Aurora's blanking timer.  The WorkBench
  630.         status window will continue to update while Aurora is INACTIVE,
  631.         however Aurora will not enter it's screen or mouse blanking
  632.         routines.
  633.           The Commodities Exchange REMOVE gadget will cause Aurora to
  634.         free all it's resources and exit.
  635.           You may also invoke and exit the Preference Editor through the
  636.         Commodities Exchange SHOW INTERFACE and HIDE INTERFACE gadgets.
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.  
  669.                                         9
  670.  
  671.  
  672.         Aurora Display Driver Capabilities
  673.  
  674.           The Amiga_ECS display driver requires KickStart 2.04 or above. 
  675.         It is capable of using any Amiga screen with the exceptions of
  676.         HAM and Extra Halfbright displays..  The maximum number of colors
  677.         used depends on the screen resolution.  Hires screens use 16
  678.         colors and Lores screens use 32 colors.  Amiga AGA and Picasso II
  679.         users can open any screen with 256 colors using this driver.  The
  680.         color accuracy of this driver is 16 levels per Red, Green, and
  681.         Blue pens for a total palette of 4,096 colors.  The
  682.         Amiga_ECS/WorkBench 2.x combination is capable of loading ONLY
  683.         IFF formated images.  The Amiga_ECS/WorkBench 3.x combination
  684.         uses datatypes to load images.  It can therefore load any image
  685.         format that you have a datatype for.
  686.           The Amiga_AGA display driver requires KickStart 3.0 or above. 
  687.         Amiga_AGA is identical to the Amiga_ECS driver except for the
  688.         color accuracy.  The Amiga_AGA driver is accurate to 256 levels
  689.         per Red, Green, and Blue pens for a total palette of 16,277,216
  690.         colors.  The  Amiga_AGA display driver uses datatypes to load
  691.         images.  It can therefore load any image format that you have a
  692.         datatype for.  Picasso II users should select this driver if
  693.         running under WorkBench 3.0 or above.
  694.           The OpalVision display driver requires KickStart 2.04 or
  695.         above, an OpalVision display card, and any version of
  696.         opal.library.  OpalVision always uses a 256 color screen at one
  697.         of the following resolutions:
  698.  
  699.           Display      Std       Oscan
  700.           Lores        320x200   384x236
  701.           LoresLaced   320x400   384x476
  702.           Hires        640x200   768x236
  703.           HiresLaced   640x400   768x476
  704.  
  705.           PAL resolutions are also used if you specify a PAL ModeID. 
  706.         The OpalVision driver is capable of loading any image format
  707.         supported by the OpalVision library and the OpalVision
  708.         Loader/Saver Interface standard.
  709.           For Workbench 3.x users, Aurora comes with an OpalVision
  710.         datatypes.loader that will allow Aurora and all other OpalVision
  711.         applications (OpalPaint, OpalPresents!, etc) to load any image
  712.         format that you have a datatype for. This loader requires the
  713.         commercial version of Aurora to completely load a datatypes
  714.         image.
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.  
  724.  
  725.                                        10
  726.  
  727.  
  728.         Aurora Module Descriptions
  729.  
  730.           The following sections describe each module provided with
  731.         Aurora, the variables they support, and the general way each
  732.         module operates.
  733.  
  734.         Common Information
  735.           Several of the modules support a variable called "Color
  736.         Increment/Decrement".  The color increment/decrement value is a
  737.         number from zero to seven.  Think of it as how fast colors will
  738.         change on screen.  A color increment value of zero means the
  739.         color will increment by one, giving a very gradual color shift. 
  740.         A value of three will increment the color by eight, so the shift
  741.         becomes faster.  It also reduces the number of possible colors
  742.         per pen.  Instead of 256 levels each of red, green, and blue, you
  743.         only have (256/8) or 32 levels.  The following table gives the
  744.         variable values, increment amount, and total colors possible for
  745.         each variable value:
  746.  
  747.           OpalVision/Amiga_AGA
  748.           Value   Increment Total Colors
  749.           0       1         256 out of 16,777,216
  750.           1       2         256 out of 2,097,152
  751.           2       4         256 out of 262,144
  752.           3       8         256 out of 32,768
  753.           4       16        256 out of 4,096
  754.           5       32        256 out of 512
  755.           6       64        64 out of 64
  756.           7       128       8 out of 8
  757.  
  758.           Amiga_ECS (LoRes Screen)
  759.           Value   Increment Total Colors
  760.           0       1         32 out of 4,096
  761.           1       2         32 out of 4,096
  762.           2       4         32 out of 4,096
  763.           3       8         32 out of 4,096
  764.           4       16        32 out of 4,096
  765.           5       32        32 out of 512
  766.           6       64        32 out of 64
  767.           7       128       8 out of 8
  768.  
  769.           All palette files provided with Aurora contain a 256 color
  770.         'CMAP' IFF chunk and were generated using Art Department
  771.         Professionals' Palette Editor.
  772.           All modules support saving the blanking screen as an IFF
  773.         image.  This can be accomplished by pressing F10 while Aurora is
  774.         blanked.  The F10 key is valid only while Aurora is blanked.  The
  775.         IFF images will be saved in the Aurora:IFF/ directory as
  776.         sequentially numbered files starting with "AuroraIFF.0001".
  777.  
  778.         Arexx Module
  779.           The Arexx module enables Arexx scripts to be used as blanking
  780.  
  781.                                        11
  782.  
  783.  
  784.         routines.  It creates the host name of 'Arexx_Module' and
  785.         supports two commands.
  786.           The 'QUERY' command informs the script of Aurora's status.  A
  787.         result code of 0 means that no input activity has been detected
  788.         and you can continue with your script's execution.  A result code
  789.         of 5 means that Aurora needs to unblank, so exit your script and
  790.         return control.
  791.           The 'QUIT' command informs the Arexx module that you are
  792.         exiting and that control may be passed back to Aurora.  The
  793.         module will wait a user definable number of seconds from the time
  794.         Aurora commands it to exit to receive this command.  If you
  795.         haven't issued the 'QUIT' command and exited your script within
  796.         this time frame, the module will exit anyway.  This will result
  797.         in your Arexx script getting an "Invalid function host" error the
  798.         next time it tries to find the "Arexx_Module" port.
  799.           If you intend to write Arexx scripts for this module, you
  800.         should issue the 'QUERY' command on a regular basis and follow
  801.         the proper route as dictated by the result code.
  802.           The Arexx module supports two variables, VAR0 is the time in
  803.         seconds the Arexx module will wait for someone to "talk" to it
  804.         before shutting down.  STR0 is the path/filename of the Arexx
  805.         script to execute.  There is not a default value for this
  806.         variable, so by not specifying a valid script name, the module
  807.         will fail (Aurora will unblank immediately).
  808.  
  809.         Aswarm Module
  810.           The Aswarm module simulates a group of bees chasing a number
  811.         of wasps, while the color of the bees is constantly changed.
  812.           The Aswarm module supports four variables.  VAR0 is the number
  813.         of wasps that will be chased, VAR1 is the number of bees that
  814.         will do the chasing, and VAR2 is the tightness of the bee groups. 
  815.         A higher value of tightness will keep the bees closer together.
  816.           STR0 specifies the 256 color palette file to use for bee color
  817.         changing.  If STR0 is not specified, the default palette
  818.         Aurora:IFF/HSV.palette will be used.
  819.  
  820.         Clock Module
  821.           The Clock module starts by drawing an analog clock face with
  822.         random colors.  Each minute the colors are repicked and altered
  823.         on screen.  The clock contains hour, minute, and second hands.
  824.  
  825.         Cycle Module
  826.           The Cycle module starts by loading a color or grayscale image. 
  827.         It then picks a random color and starts palette cycling to reach
  828.         that color.
  829.           Cycle supports two variables.  VAR0 is the color
  830.         increment/decrement value.  STR0 is the filename of an IFF
  831.         pattern image.  If STR0 is left blank, a random image from your
  832.         default image directory will be chosen.
  833.  
  834.  
  835.         Julia Module
  836.  
  837.                                        12
  838.  
  839.  
  840.           The Julia module first selects a random point from the
  841.         Mandelbrot set and tests its location for color variations.  If
  842.         the color variations meet certain criteria, a random starting
  843.         color is picked and the Julia fractal is generated.
  844.           Based on the random coordinate/first color selections, the
  845.         number of different Julia images that can be generated is
  846.         astronomical.
  847.           The variables supported by this module are VAR0 and STR0. 
  848.         VAR0 is the number of iterations used.  The higher the iteration,
  849.         the more detailed the image.  STR0 is the name of the 256 color
  850.         palette file to use.  This module uses double precision floating
  851.         point math.
  852.  
  853.         JuliaFP Module
  854.           The JuliaFP module is identical to the Julia module with the
  855.         exceptions of the required processor and the type of math used. 
  856.         This module requires a 68030 or better processor and a
  857.         68881/68882 math coprocessor.
  858.  
  859.         Lines Module
  860.           The Lines module draws sequentially positioned lines, with
  861.         each line's color offset from the previous one.  This module
  862.         supports three variables.  VAR0 is the number of line sets, VAR1
  863.         is the number of lines per set, and VAR2 is the color
  864.         increment/decrement value.
  865.           Each line is allocated it's own palette entry, which allows
  866.         one line per screen color, less one, at any given time (palette
  867.         entry 0 is used for the black background).  The number of sets
  868.         times the number of lines must be less than the number of screen
  869.         colors.
  870.  
  871.         Mandelbrot Module
  872.           The Mandelbrot module first selects a window size based on the
  873.         full width/height of the MandelBrot set, divided by a random zoom
  874.         level.  It then selects a random area for the window and tests
  875.         its perimeters for color variations.  If the color variations
  876.         meet certain criteria, a random starting color is picked and the
  877.         mandelbrot is generated.
  878.           Based on the random coordinate/zoom level/first color
  879.         selections, the number of different mandelbrot images that can be
  880.         generated is astronomical.
  881.           The variables supported by this module are VAR0 and STR0. 
  882.         VAR0 is the number of iterations used.  The more iterations, the
  883.         more detailed the image.  STR0 is the name of the 256 color
  884.         palette file to use.  This module uses double precision floating
  885.         point math.
  886.  
  887.         MandelbrotFP Module
  888.           The MandelbrotFP module is identical to the Mandelbrot Module
  889.         with the exceptions of the required processor and the type of
  890.         math used.  This module requires a 68030 or better processor and
  891.         a 68881/68882 math coprocessor.
  892.  
  893.                                        13
  894.  
  895.  
  896.         Marquee Module
  897.           The Aurora Marquee module uses a two color native Amiga screen
  898.         (THIS MODULE DOES NOT USE THE SELECTED DISPLAY DRIVER!) with the
  899.         resolution specified by the Variable Editor.  This module
  900.         supports three numeric variables and two string variables.
  901.           Marquee renders and scrolls user specified text horizontally
  902.         across a black screen, randomly changing the text color and
  903.         vertical position with each pass.
  904.           VAR0 is the font vertical size in pixels.  Depending on your
  905.         screen resolution and font size, the font might not fit the
  906.         screen.  In this event, a default font size of 1/5 screen height
  907.         will be used.
  908.           VAR1 is the font style sum.  The following table lists all 7
  909.         style sum combinations:
  910.  
  911.  
  912.           VAR1 Style
  913.           0    Normal (defined in actual font)
  914.           1    Underlined
  915.           2    Bold
  916.           3    Underlined and Bold
  917.           4    Italic
  918.           5    Italic and Underlined
  919.           6    Italic and Bold
  920.           7    Italic, Underlined, and Bold
  921.  
  922.           VAR2 is the scrolling speed.  This is the horizontal distance
  923.         in pixels between each new text rendering.
  924.           STR0 is the name of the font to use.  This can be any font you
  925.         desire, but compugraphic fonts work the best.  The default font
  926.         is CGTimes which is supplied with the Amiga system software.
  927.           STR1 is the text you want rendered.  Something to note is that
  928.         the longer you make this string, the slower the text will scroll.
  929.  
  930.         Mystic Module
  931.           The Aurora Mystic module draws sequentially positioned
  932.         triangles with each triangle's color offset from the previous
  933.         one.  VAR0 is the number of triangle sets, VAR1 is the number of
  934.         triangles per set, and VAR2 is the color increment/decrement
  935.         value.
  936.           Each triangle is allocated it's own palette entry, which
  937.         allows the number of screen colors (less one) triangles on screen
  938.         at any given time (palette entry 0 is used for the black
  939.         background).  The number of sets times the number of triangles
  940.         must be less than the number of screen colors.
  941.  
  942.         Null Module
  943.           The Null module opens a blank black screen, turns copper and
  944.         bitplane DMA off, and then goes to sleep.  It stays asleep until
  945.         Aurora commands it to exit.  This module is intended for use when
  946.         rendering or other processor intensive tasks are running. 
  947.         Virtually no CPU resources are expended on Aurora or it's module
  948.  
  949.                                        14
  950.  
  951.  
  952.         during this time.
  953.           This module writes directly to hardware registers, so future
  954.         Amiga model compatibility is questionable.
  955.  
  956.         Plasma Module
  957.           The Plasma module generates a plasma fractal image in four
  958.         passes, while randomly picking and cycling in new palette colors.
  959.           This module supports one variable.  VAR0 is the color
  960.         increment/decrement value.
  961.  
  962.         Puzzle Module
  963.           The Puzzle module loads an image and treats it as a sliding
  964.         puzzle.  It randomly selects one square out of a grid, clears
  965.         that square, and slides one of the four surrounding squares to
  966.         fill that gap.  This leaves another empty square, it is then
  967.         filled, and so on.
  968.           This module supports two variables.  VAR0 is the number of
  969.         horizontal and vertical units in the grid, and STR0 is the image
  970.         name (including path) to load.  If STR0 is not specified or is an
  971.         invalid filename, Aurora will pick one from your default image
  972.         directory.
  973.  
  974.         Raindrops Module
  975.           The Raindrops module generates random colored ellipses and
  976.         rotates the palette to give the appearance of raindrops and their
  977.         fading ripples.  This module REQUIRES 32 palette entries to
  978.         function, so Amiga_ECS users must use a Low Resolution or Low
  979.         Resolution Interlaced screen with this module.
  980.  
  981.         Random Module
  982.           The Random module is not really a module per se.  It selects
  983.         one of the other modules for execution.  It also ensures each
  984.         module is ran at least once before it begins repetitive
  985.         selections.
  986.  
  987.         SlideShow Module
  988.           The SlideShow module sequentially displays all loadable image
  989.         formats in a specified directory.  For the OpalVision Display
  990.         Driver, loadable formats include IFF, JPEG, and any LSI modules
  991.         you may have installed.  The Amiga AGA Display Driver loadable
  992.         formats are anything you have a datatype for.  The Amiga ECS
  993.         Display Driver loadable formats are IFF only.  It supports two
  994.         variables; VAR0 is the delay in seconds between images, and STR0
  995.         is the path to your images.
  996.  
  997.         Squares Module
  998.           The Squares module draws a square with black borders and moves
  999.         it randomly across the screen at varying speeds, leaving the
  1000.         previous square visible.  The color of each square varies from
  1001.         the previous square by the amount specified through the color
  1002.         increment/decrement value.
  1003.           This module supports one variable, VAR0, which is the color
  1004.  
  1005.                                        15
  1006.  
  1007.  
  1008.         increment/decrement.
  1009.  
  1010.         Starfield Module
  1011.           The Starfield module generates a 3D starfield effect similar
  1012.         to those you see in the movies and on TV.  The star color is
  1013.         dependant on its distance from the camera.  The further away it
  1014.         is, the darker it is.
  1015.           Starfield supports two variables.  VAR0 is the maximum number
  1016.         of stars on screen at any given time, and VAR1 is the speed at
  1017.         which you are traveling through the field.
  1018.  
  1019.  
  1020.  
  1021.  
  1022.  
  1023.  
  1024.  
  1025.  
  1026.  
  1027.  
  1028.  
  1029.  
  1030.  
  1031.  
  1032.  
  1033.  
  1034.  
  1035.  
  1036.  
  1037.  
  1038.  
  1039.  
  1040.  
  1041.  
  1042.  
  1043.  
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061.                                        16
  1062.  
  1063.  
  1064.         Aurora Arexx Interface Information
  1065.  
  1066.           Aurora's Arexx interface supports virtually all of the
  1067.         Preference Editor options.  Aurora's Arexx port is named
  1068.         "Aurora_Rexx".  Do not confuse this Arexx compatibility with the
  1069.         Arexx module.  They are two completely separate entities.  This
  1070.         section deals only with the main Aurora program's Arexx
  1071.         capabilities.
  1072.           Aurora scripts should contain the OPTION RESULTS command to
  1073.         enable RESULT based status/variable querying.
  1074.  
  1075.         MODULE Command
  1076.           MODULE  <name>
  1077.           This command sets the module to use for blanking.  Sending
  1078.         MODULE by itself will set RESULT to the current module selection.
  1079.  
  1080.         DRIVER Command
  1081.           DRIVER  <name>
  1082.           This command sets the display driver to use.  Sending DRIVER
  1083.         by itself will set RESULT to the current display driver
  1084.         selection.
  1085.  
  1086.         TIME Command
  1087.           TIME <seconds>
  1088.           This command sets the screen blanker inactivity period. 
  1089.         Specifying a numeric value after the TIME keyword will set the
  1090.         new time.  Sending TIME by itself will set RESULT to the current
  1091.         screen blanker inactivity period setting.
  1092.  
  1093.         MOUSETIME Command
  1094.           MOUSETIME <seconds>
  1095.           This command sets the mouse blanker inactivity period. 
  1096.         Specifying a numeric value after the MOUSETIME keyword will set
  1097.         the new time.  Sending MOUSETIME by itself will set RESULT to the
  1098.         current mouse blanker inactivity period setting.
  1099.  
  1100.         OSCAN Command
  1101.           OSCAN   ON|OFF
  1102.           This command acts as a toggle for the overscan screen flag. 
  1103.         Specifying OSCAN ON sets the overscan flag, while OSCAN OFF
  1104.         clears it.  Specifying OSCAN by itself will set RESULT based on
  1105.         the condition of the OSCAN setting, either ON or OFF.
  1106.  
  1107.         MODEID Command
  1108.           MODEID  0x00000000
  1109.           This command sets the display mode ID that Aurora will use for
  1110.         backdrop screens, and as the default module ModeID if one is not
  1111.         specified through the MODULEMODEID command.  The number specified
  1112.         must be an eight digit hexadecimal number preceded with '0x'.
  1113.  
  1114.         MODULEMODEID Command
  1115.           MODULEMODEID   0x00000000
  1116.  
  1117.                                        17
  1118.  
  1119.  
  1120.           This command sets the display mode ID that the module will use
  1121.         for its blanking screen.  The number specified must be an eight
  1122.         digit hexadecimal number preceded with '0x'.
  1123.  
  1124.         WINDOW Command
  1125.           WINDOW  ON|OFF
  1126.           This command acts as a toggle for the Workbench status window. 
  1127.         Specifying WINDOW ON will open the status window if it is not
  1128.         already opened.  Specifying WINDOW OFF will close the window. 
  1129.         Specifying WINDOW by itself will set RESULT based on the
  1130.         condition of the WINDOW setting, either ON or OFF.
  1131.  
  1132.         VARx Command
  1133.           VARx <value>
  1134.           This command sets one of five numeric variables.  x can equate
  1135.         to 0 through 4.  <value> can be any numeric value.  Specifying
  1136.         VARx by itself will set RESULT to the current value of VARx. 
  1137.         There is no range checking done on Arexx variable settings as
  1138.         this varies with the module.  Any invalid variable value will be
  1139.         ignored and the module will use its default values.
  1140.  
  1141.         STRx Command
  1142.           STRx <string>
  1143.           This command sets one of five string variables.  x can equate
  1144.         to 0 through 4.  <string> can be any alphanumeric text. 
  1145.         Specifying STRx by itself will set RESULT to the current value of
  1146.         STRx.
  1147.  
  1148.         HANGUP Command
  1149.           HANGUP
  1150.           This command drops the serial ports' DTR signal, forcing a
  1151.         disconnect on modems supporting DTR.  This option is only valid
  1152.         when the 'Serial Carrier' or 'Serial Ring' events are selected
  1153.         from the Preference Editor.  Not all modems treat the dropping of
  1154.         DTR the same, please consult your modem manual for additional
  1155.         information.
  1156.  
  1157.         UNBLANK Command
  1158.           UNBLANK
  1159.           This command causes Aurora to unblank as if you moved the
  1160.         mouse or pressed a key.  If Aurora is not currently blanked this
  1161.         command has no effect.
  1162.  
  1163.         QUIT Command
  1164.           QUIT
  1165.           This command forces Aurora to unblank, free all of its
  1166.         resources, and exit.
  1167.  
  1168.         RANDOMTIME Command
  1169.           RANDOMTIME   <minutes>
  1170.           This command sets the random module change period.  Specifying
  1171.         a numeric value after the RANDOMTIME keyword will set the new
  1172.  
  1173.                                        18
  1174.  
  1175.  
  1176.         time limit.  If you set the time to zero, the random module
  1177.         change feature will be disabled.  Sending RANDOMTIME by itself
  1178.         will set RESULT to the current random module change period
  1179.         setting.
  1180.  
  1181.         SOUND Command
  1182.           SOUND   <filename>
  1183.           This command sets the path and filename to the Protracker .MOD
  1184.         file to use during screen blanking.  Sending SOUND by itself will
  1185.         set RESULT to the current .MOD path and filename.
  1186.  
  1187.         STARTCMD Command
  1188.           STARTCMD  <command>
  1189.           This command defines the system DOS command to be performed at
  1190.         the start of a screen blanking cycle.  <command> should be the
  1191.         complete path, filename, and arguments for the desired DOS
  1192.         command.  Sending STARTCMD by itself will set RESULT to the
  1193.         current start command.
  1194.  
  1195.         STOPCMD Command
  1196.           STOPCMD   <command>
  1197.           This command defines the system DOS command to be performed at
  1198.         the end of a screen blanking cycle.  <command> should be the
  1199.         complete path, filename, and arguments for the desired DOS
  1200.         command.  Sending STOPCMD by itself will set RESULT to the
  1201.         current stop command.
  1202.  
  1203.  
  1204.  
  1205.  
  1206.  
  1207.  
  1208.  
  1209.  
  1210.  
  1211.  
  1212.  
  1213.  
  1214.  
  1215.  
  1216.  
  1217.  
  1218.  
  1219.  
  1220.  
  1221.  
  1222.  
  1223.  
  1224.  
  1225.  
  1226.  
  1227.  
  1228.  
  1229.                                        19
  1230.  
  1231.  
  1232.         Common ModeID Values for WB2.x Users
  1233.  
  1234.           The following list gives ModeID values for all screen
  1235.         resolutions available with the Enhanced Chip Set/OpalVision
  1236.         combination.
  1237.  
  1238.           Display Name        ModeID
  1239.           NTSC High Res       00019000
  1240.           NTSC High Res Laced 00019004
  1241.           NTSC Low Res        00011000
  1242.           NTSC Low Res Laced  00011004
  1243.           PAL High Res        00029000
  1244.           PAL High Res Laced  00029004
  1245.           PAL Low Res         00021000
  1246.           PAL Low Res Laced   00021004
  1247.  
  1248.           AGA Chipset/OpalVision Display Driver Users - The Default
  1249.         ModeID under the Preference Editor's "Switches Section" must be
  1250.         one of the above for the OpalVision screen to synchronize to the
  1251.         backdropped Amiga screen.
  1252.  
  1253.  
  1254.  
  1255.  
  1256.  
  1257.  
  1258.  
  1259.  
  1260.  
  1261.  
  1262.  
  1263.  
  1264.  
  1265.  
  1266.  
  1267.  
  1268.  
  1269.  
  1270.  
  1271.  
  1272.  
  1273.  
  1274.  
  1275.  
  1276.  
  1277.  
  1278.  
  1279.  
  1280.  
  1281.  
  1282.  
  1283.  
  1284.  
  1285.                                        20
  1286.